home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
EnigmA Amiga Run 1995 November
/
EnigmA AMIGA RUN 02 (1995)(G.R. Edizioni)(IT)[!][issue 1995-11][Skylink CD].iso
/
earcd
/
program
/
misc
/
bgui12.lha
/
docs
/
stringclass.doc
< prev
next >
Wrap
Text File
|
1995-06-05
|
3KB
|
99 lines
File: stringclass.doc
Description: Stringclass documentation.
Copyright: (C) Copyright 1994-1995 Jaba Development.
(C) Copyright 1994-1995 Jan van den Baard.
All Rights Reserved.
------------------------------------------------------------------------------
TABLE OF CONTENTS
stringclass/--background--
stringclass/Methods
stringclass/Attributes
stringclass/--background-- stringclass/--background--
NAME
Class: stringclass
Superclass: baseclass
Include File: <libraries/bgui.h>
FUNCTION
To provide gadget simular to the gadtools.library it's string and
integer gadget kinds. Objects from this class sends out the following
attribute pairs in their notification events:
GA_ID - Gadget object ID.
STRINGA_TextVal - Gadget object string contents (string objects).
STRINGA_LongVal - Gadget object integer contents (integer objects).
stringclass/Methods stringclass/Methods
NEW METHODS
SM_FORMAT_STRING -- This method may be used to set a formatted string
in a string object. The formatted string may also contain any
locale.library compatible formatting codes. This method uses
the following custom message structure:
struct smFormatString {
ULONG MethodID; /* SM_FORMAT_STRING */
struct GadgetInfo *smfs_GInfo; /* GadgetInfo */
UBYTE *smfs_FStr; /* Format string */
ULONG smfs_Arg1; /* Format arg */
/* ULONG smfs_Arg2; */
/* ... */
};
smfs_GInfo -- This must point to a valid GadgetInfo structure
if the change must also be shown visually on screen.
The BGUI_DoGadgetMethod() call will automatically
construct this for you.
smfs_FStr -- This must point to a 0-terminated string which
contains the formatting codes. Also all locale.library
it's FormatString() formatting codes are supported
when the locale.library is available.
amfs_Arg1 -- This must be the first argument that the string
expects. This can be followed by as much arguments as
are expected by the specified formatting string.
NOTE: This method will only work on string objects. Not on
integer objects.
Returns TRUE uppon success and FALSE uppon failure.
CHANGED METHODS
None.
stringclass/Attributes stringclass/Attributes
NOTE
All system strgclass attributes are also supported by this class.
Please refere to the documentation on the strgclass for more
information on these attributes.
NAME
STRINGA_MinCharsVisible -- ( ULONG ) ** V39 **
FUNCTION
To make it possible to determine the minimum amount of characters
which should always stay visible.
Default is 2. Applicability is (I).
NAME
STRINGA_IntegerMin, STRINGA_IntegerMax -- ( ULONG ) ** V39 **
FUNCTION
To set the minimum and maximum value which the integer object can
hold. When a STRINGA_LongVal is set which is out of this range the
value is adjusted to be inside these boundaries. Also when the user
enters a value outside these boundaries the screen will flash and the
entered value is adjusted and not accepted.
Defaults are 0xEFFFFFFF minimum and 0x0FFFFFFF maximum. Applicability
is (ISU).